Bug 562998 – GtkFontButton documentation improvements

2008-12-03  Sven Herzberg  <sven@imendio.com>

	Bug 562998 – GtkFontButton documentation improvements

	* gtk/gtkfontbutton.c: mention the way the font string should be used.
	Patch by Sven Herzberg and Nelson Benitez

svn path=/trunk/; revision=21842

diff --git a/ChangeLog b/ChangeLog
index 3f4046b5e34d6db7cf5170f0009c912016678b7d..ec1e31664fb99759501e11dbf458164c9322bb36 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-12-03  Sven Herzberg  <sven@imendio.com>
+
+       Bug 562998 – GtkFontButton documentation improvements
+
+       * gtk/gtkfontbutton.c: mention the way the font string should be used.
+       Patch by Sven Herzberg and Nelson Benitez
+
 2008-12-03  Marek Kasik  <mkasik@redhat.com>
 
        Bug 559914 – eog doesn't apply paper setup.

diff --git a/gtk/gtkfontbutton.c b/gtk/gtkfontbutton.c
index a4c6788cdbed6629969d5d9b0142d208f3639d14..362860254bdc30c944d3984a362635a5bee767d5 100644 (file)
--- a/gtk/gtkfontbutton.c
+++ b/gtk/gtkfontbutton.c
@@ -628,7 +628,12 @@ gtk_font_button_set_show_size (GtkFontButton *font_button,
  * gtk_font_button_get_font_name:
  * @font_button: a #GtkFontButton
  *
- * Retrieves the name of the currently selected font.
+ * Retrieves the name of the currently selected font. This name includes
+ * style and size information as well. If you want to render something
+ * with the font, use this string with pango_font_description_from_string() .
+ * If you're interested in peeking certain values (family name,
+ * style, size, weight) just query these properties from the
+ * #PangoFontDescription object.
  *
  * Returns: an internal copy of the font name which must not be freed.
  *